Skip to content

feat: identities getting started #2103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
May 2, 2025
Merged

feat: identities getting started #2103

merged 28 commits into from
May 2, 2025

Conversation

christiannwamba
Copy link
Contributor

@christiannwamba christiannwamba commented Apr 8, 2025

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

Organization after getting started

@christiannwamba
Copy link
Contributor Author

christiannwamba commented Apr 10, 2025

TODO:

  • Add a page for password reset/account recovery
  • Remove initialize sdk example from login page
  • Use brew (not npm) to install ory cli and show instructions for macos and linux
  • Use @ory/client-fetch (not @ory/client)
  • Set credentials to include instead of usine withCredentials
  • Use UI component for screenshots
  • Refine screenshots to be clear and annotated
  • Make UI texts bold
  • instead ui /ui/login please redirect to the route behind createBrowserLoginFlow
  • Add ory cli as alternative tab to Ory Console

@christiannwamba
Copy link
Contributor Author

christiannwamba commented Apr 10, 2025

Feedback from @piotrmsc

  • Refine local development
  • Print the session to console
  • Remove headers from code snippets
  • Extend the session and revoke the session using code
  • Use MS style guide for handling list in MFA page
  • Use a single image for the MFA config
  • Remove the list of provider and link to it
  • Fix social sign in image
  • Replace blur with template value
  • Link to session guide instead of configuring session

  • Bullet list might not be needed
  • Refresh and revoke session test
  • Consisteent basepath url
  • Image urls
  • Double check the mfa settings to see if they get an email
  • Consider whether or not to have the Next steps section
  • Remove the recommended approach section

Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Structurally it's going in the right direction, but I think we need a bit more work on the content side!

@piotrmsc
Copy link
Collaborator

piotrmsc commented Apr 15, 2025

Following again blindly "step by step" : When I try logout I am getting 404 after logout call as well, in ory tunnel I see calls and redirects but in the end I end up with 404 from CF blocking rule, do I need to configure something extra?

vinckr
vinckr previously requested changes Apr 16, 2025
Copy link
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huge PR!
I think we are very close to getting this one perfect and will be a great basis for getting started!

I did not test all the code examples but the ones I tested were straightforward enough - maybe you can create an issue to add automated tests for these examples later on? I think long-term would be good avoid drift.

I also noticed you added some neat new(?) components, love them!

Please track adding a "custom components" section to the README in a followup issue - so others know how to use these components? It is mostly clear from this example, but it could save us some time in the future - you don't need to do it in this PR though.

All in all I had mostly some minor style issues, nothing major. Let me know where you had followup questions, once we have this resolved let's :shipit:

@piotrmsc
Copy link
Collaborator

Huge PR! I think we are very close to getting this one perfect and will be a great basis for getting started!

I did not test all the code examples but the ones I tested were straightforward enough - maybe you can create an issue to add automated tests for these examples later on? I think long-term would be good avoid drift.

I agree with the idea of tests,however, to have them running and testing the code examples they would need to be code-complete and currently are not (see my previous review comments on them). Which for me would make sense to have getting-started code examples as code complete with option to collapse lines of code that are not ory-specific.

@christiannwamba what's your take on it?

@vinckr vinckr force-pushed the draft-identities-guide branch from 3906aef to e9d1b70 Compare May 2, 2025 10:01
@vinckr vinckr enabled auto-merge (squash) May 2, 2025 10:01
@vinckr vinckr merged commit c758594 into master May 2, 2025
9 checks passed
@vinckr vinckr deleted the draft-identities-guide branch May 2, 2025 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants